Skip to content

Refresh help files with complete method listings and paper mapping#50

Merged
iahncajigas merged 1 commit intomainfrom
docs/help-files-refresh
Mar 10, 2026
Merged

Refresh help files with complete method listings and paper mapping#50
iahncajigas merged 1 commit intomainfrom
docs/help-files-refresh

Conversation

@iahncajigas
Copy link
Copy Markdown
Contributor

Summary

  • ClassDefinitions.md: Expanded from bare class table to full grouped method listings for all 16 classes, including new SignalObj spectral/peak-finding, FitResSummary plotting, DecodingAlgorithms SSGLM/UKF, and nstColl.ssglm methods
  • PaperOverview.md: Added SSGLM workflow section (Section 2.4), expanded decoding workflow with PPAF/hybrid/UKF details, added signal processing section, added example-to-paper-section mapping table
  • Examples.md: Added self-contained paper example table with descriptions, supplementary README examples section
  • NeuralSpikeAnalysis_top.md: Expanded landing page with key capabilities summary, lab links, PMID
  • api.rst: Fixed incorrect module names (nstat.signal -> nstat.core, nstat.decoding -> nstat.decoding_algorithms), added complete public import listing

Test plan

  • Sphinx docs build passes (python -m sphinx -W -b html docs docs/_build/html)
  • All CI checks pass
  • GitHub Pages rebuilds after merge

🤖 Generated with Claude Code

- ClassDefinitions.md: expand from bare class table to full grouped
  method listings for all 16 classes including new SignalObj spectral/
  peak-finding, FitResSummary plotting, DecodingAlgorithms SSGLM/UKF,
  and nstColl.ssglm methods
- PaperOverview.md: add SSGLM workflow section (Section 2.4), expand
  decoding workflow with PPAF/hybrid/UKF details, add signal processing
  section, add example-to-paper-section mapping table
- Examples.md: add self-contained paper example table with descriptions,
  add supplementary README examples section
- NeuralSpikeAnalysis_top.md: expand landing page with key capabilities
  summary, lab website links, PMID citation
- api.rst: fix incorrect module names (nstat.signal -> nstat.core,
  nstat.decoding -> nstat.decoding_algorithms), add complete public
  import listing

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@iahncajigas iahncajigas merged commit c654b24 into main Mar 10, 2026
13 checks passed
@iahncajigas iahncajigas deleted the docs/help-files-refresh branch March 11, 2026 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant